home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 25 / Cream of the Crop 25.iso / bbs / mue018.zip / MUE.DOC < prev    next >
Text File  |  1997-04-20  |  21KB  |  456 lines
  1.     ┌─────────────────────────────────────────────────────────────────────┐
  2.     │ Maximus                                         Copyright  1997     │
  3.     │  User                Documentation             cooke@playcom.com    │
  4.     │   Editor                                    Written by: Larry Cooke │
  5.     └─────────────────────────────────────────────────────────────────────┘
  6.  
  7.     As much as I have tried to make this program usable without docs, it
  8.     has become necessary due to the complexity of the beast.  As they say,
  9.     documentation is the worst part for a programmer and I guess I'm no
  10.     exception to this saying...  Hopefully I'll cover the basics without
  11.     boring you too much.
  12.  
  13.     There are five files in this archive,  MUE.DOC, MUE(p).EXE, MUE.HLP,
  14.     MUEDESC.ZIP, and HISTORY.TXT. The MUE.HLP file is a text file that you
  15.     can edit to suit your needs.  This file is what's displayed when you
  16.     press the F1 key in MUE.
  17.  
  18.     MUEDESC.ZIP contains a sample Mex and Mecca file that allows you to
  19.     utilize the add description feature (/a#).  If you have a need to add
  20.     a description to users on your system automatically then check this
  21.     archive out.
  22.  
  23.     MUE can be ran from any directory, however you must either have the
  24.     MAXIMUS environment set or provide the path and file name to your
  25.     MAX.PRM file with the command line switch /M.  MUE's logic when first
  26.     loading is to use command line switches with priority over the MAXIMUS
  27.     environment setting, if no command line switch is specified then it
  28.     looks in the current directory, lastly it will use the MAXIMUS
  29.     environment.  The bottom line is MUE must know where your MAX.PRM file
  30.     is, with out it MUE will just waste disk space. :-)  The same logic
  31.     applies to the USER.BBS file (or whatever name you use.)
  32.  
  33.     MUE will look in the current directory for the MUE.CFG and MUE.HLP
  34.     files. If they don't exist there, then it will be assumed they are in
  35.     the same directory as your USER.BBS file.  For those that don't want
  36.     them in the \MAX directory, or where ever you keep the USER.BBS file,
  37.     you'll need to start MUE in the directory where you want them stored.
  38.  
  39.     Make a backup copy of your USER.BBS and USER.EXT files prior to running
  40.     MUE!  I have done a lot of testing with this version to be sure it
  41.     won't harm anything, but as usual, your mileage could vary.  Keep one
  42.     thing in mind, if you decide to delete a valid user you will wipe out
  43.     his last read pointers and his MTag file (the message tag list for the
  44.     OLR.)  I recommend appending a new test user and then playing with that
  45.     record.
  46.  
  47.     ──────────────────────────── Licensing: ───────────────────────────────
  48.  
  49.     Use of MUE follows the same guidelines as Maximus.  It's free for non-
  50.     commercial users, if your are a commercial user then you must register
  51.     this program.  Registration fee's are $25.00 for site licenses. Contact
  52.     me at cooke@playcom.com or 1:300/53 on how to obtain a license.
  53.  
  54.     ───────────────────── Key Presses and their uses: ─────────────────────
  55.  
  56.     For the most part this section is a long winded version the MUE.HLP
  57.     file included in the archive.  However some keys may not be listed in
  58.     the help file and perhaps some more detail on the keys and uses may be
  59.     of help here.
  60.  
  61.     = (equal) - Toggles the displaying of user passwords.  Note that
  62.                 sysop level user passwords are not displayed.  This
  63.                 is a minor security attempt for prying eyes.  In all
  64.                 cases (except when encrypted passwords are used) the
  65.                 password is displayed when editing a password.
  66.     ^P or |   - (Control-P)  Packs/Purges the user base.
  67.     ^R        - (Control-R)  Restore purged users.
  68.     ^S        - (Control-S)  Sort the user base.
  69.     ALT-(Key) - This toggles the current users (key).  Example ALT-K
  70.                 toggles the K key.
  71.     ESC       - Toggles the main menu.
  72.     F1        - Displays the MUE.HLP (help) text file.
  73.     PageDn    - Jump/decrement 10 users down from the current user.
  74.     PageUp    - Jump/increment 10 users up from the current user.
  75.     Dn or Rt  - Display the next user record.
  76.     Up or LF  - Display the previous user record.
  77.     1 or Home - Jumps to the first user record.
  78.     A         - Change the current users access level.
  79.     C         - Change the current users compression method.
  80.     D or DEL  - Toggles the Delete flag for the current user.
  81.     E         - Edit non hotkey fields.
  82.     F         - Change the current users flags.
  83.     G#        - Go to user #.
  84.     H         - Change the current users Help Level.
  85.     J or END  - Jumps to the last user record.
  86.     K         - Change the current users keys.  Using this option will
  87.                 display the key values as set in the Configuration >
  88.                 Key Labels menu option.  Keys can also be toggled by
  89.                 pressing ALT-(key).  See ALT-(Key) above.
  90.     L         - Change the current users Language.
  91.     N         - Change the current users Nulls.
  92.     P         - Toggle the current users PERM flag.
  93.     R         - Change the current users Message/File Area.
  94.     S         - Search menu.
  95.     T         - Change the current users Transfer protocol.
  96.     V         - Change the current users Video Mode.
  97.     W         - Change the current users Password.
  98.     X         - Change the current users EXpiration settings.
  99.  
  100.     ──────────────────────── Command Line Switches: ───────────────────────
  101.  
  102.     First off, you can run MUE and pass the /H switch for the command line
  103.     switch help.  This yields basic help/instructions for the different
  104.     switches.
  105.  
  106.     /a## f  Adds a description to user.  This only works when the user
  107.             is online.  The ## is the node number, if running multi-node.
  108.             MUE will search for a LASTUS##.BBS file and if found it will
  109.             add the description from the f text file (file name must be
  110.             passed after the /a## value with at least one space!)
  111.  
  112.             PLEASE NOTE that this option will overwrite any description
  113.             in the users description, it does not allow you to append!
  114.  
  115.             Example:  MUE /a00 USERDESC.TXT  or  MUE /a USERDESC.TXT
  116.  
  117.             Above will add the text from the USERDESC.TXT file to the
  118.             user in the LASTUSER.BBS file.
  119.  
  120.             Example:  MUE /a01 USERDESC.TXT
  121.  
  122.             Above will look for LASTUS01.BBS and add the text from the
  123.             USERDESC.TXT file.
  124.  
  125.             Notes:  Text is limited to 165 characters, text beyond the
  126.                     165 characters length are truncated (ignored.)
  127.                     If the text is on one single line in the file, MUE
  128.                     will word wrap lines longer than 55 characters.
  129.                     On the other hand, if you have multiple lines of
  130.                     text in the file, then MUE will ignore text after
  131.                     the third line.  Try to think in terms of how the
  132.                     text is displayed while in MUE.
  133.  
  134.             Sample 1:
  135.  
  136.             This is all on one line in the text file passed to MUE(p).
  137.  
  138.             Above would be displayed in MUE like this:
  139.  
  140.               ┌──────────────────────┤Description:├─────────────────────┐
  141.               │ This is all on one line in the text file passed to      │
  142.               │ MUE(p).                                                 │
  143.               │                                                         │
  144.               └─────────────────────────────────────────────────────────┘
  145.  
  146.             Sample 2:
  147.  
  148.             This is the first line of info.
  149.             This is the second line.
  150.             This is the third line.
  151.             This is the fourth line.
  152.  
  153.             Above would be displayed in MUE like this:
  154.  
  155.               ┌──────────────────────┤Description:├─────────────────────┐
  156.               │ This is the first line of info.                         │
  157.               │ This is the second line.                                │
  158.               │ This is the third line.                                 │
  159.               └─────────────────────────────────────────────────────────┘
  160.  
  161.             Note that the fourth line is ignored.  As well, word wrapping
  162.             doesn't occur.  However, if one of the lines were longer than
  163.             55 characters, then word wrapping would occur.  It's possible
  164.             the third line could be (partially) truncated depending on
  165.             which line was longer than 55 characters.  Some experimentation
  166.             is on order if you're trying to get fancy here.
  167.  
  168.             For some examples on how to utilize this feature, check out the
  169.             MUEDESC.ZIP file.
  170.  
  171.     /b      This runs MUE in Monochrome mode.  Essentially Black & White.
  172.  
  173.             Example:  MUE /b
  174.  
  175.     /c      Configuration file switch.  This allows you to specify a path
  176.             and file name to your .CFG file.  Useful for having multiple
  177.             configuration files or keeping the .CFG file in a directory
  178.             other than the \MAX directory.
  179.  
  180.             Example: MUE /cD:\MAX\MUE02.CFG
  181.  
  182.     /g###   Go to user ###.
  183.  
  184.             Example:  MUE /g201
  185.  
  186.     /m      Maximus .PRM switch, default is the MAXIMUS environment
  187.             variable.  Use this to override or replace the MAXIMUS
  188.             environment variable.
  189.  
  190.             Example:  MUE /mD:\MAX\MAX.PRM
  191.  
  192.     /p      Purge the USER base.  This will purge users based on settings
  193.             in the Global > Purge Settings menu as well as users marked
  194.             deleted.  This switch as well as the pack/purge commands
  195.             within MUE also pack the USER.EXT file.  Useful in nightly
  196.             maintenance batches.
  197.  
  198.             Example:  MUE /p
  199.  
  200.     /sm[s]  Sort the user base.  This switch will sort the user base and
  201.             SAVE it that way.  Useful in nightly maintenance batches.
  202.  
  203.             *********READ THE FOLLOWING IF YOU USE THIS SWITCH!*********
  204.  
  205.             When saving the user base after sorting it, the USER.IDX
  206.             file MUST BE DELETED!  MUE will do this automatically,
  207.             however, if you sort the user base in a temporary directory
  208.             and move it manually, you must delete the USER.IDX file.
  209.             Failing to delete this file will yield mixed results when
  210.             Maximus is ran.  Typically Maximus will only see YOUR record
  211.             and the second record in the user base.  Deleting the USER.IDX
  212.             file will not harm anything as Maximus recreates it the next
  213.             time it is ran.
  214.  
  215.             The m field is the Major sort option and [s] is the optional
  216.             secondary sort option.  Keys for these are simply the hotkey
  217.             characters used within the Sort menu as shown below:
  218.  
  219.                 1 = 1st  Name       M = Message Area
  220.                 L = Last Name       B = DOB
  221.                 A = AccessLvl       I = AlIas
  222.                 C = City            S = LaSt Call
  223.                 P = Phone #         # = # Calls
  224.                 T = DaTa #          D = DnLoad Kb
  225.                 F = File Area       U = UpLoad Kb
  226.  
  227.             For example:  MUE /sal
  228.  
  229.             Will sort the user base by Access level and then by last name
  230.             as a secondary sort within the access levels.  Note that you
  231.             may have mixed results with the secondary sort option.  Some
  232.             major sorts don't lend well to secondary sorts.  This was
  233.             implemented mostly for sorting by names within the Access
  234.             Level sort.
  235.  
  236.     /u      User base switch.  Use this to override the MAX.PRM setting.
  237.             Useful for testing purposes more than anything else.
  238.  
  239.             Example:  MUE /uD:\MAX\USER.BBS
  240.  
  241.     ────────────────────── Files created/used by MUE: ─────────────────────
  242.  
  243.     First of all MUE requires a Maximus version 3.0x USER.BBS file, second
  244.     it requires your MAX.PRM file.  Due to the flexibility of Maximus 3.0x,
  245.     the MAX.PRM file is an absolute necessity for MUE. For this reason, you
  246.     must have an environment variable set for Maximus or you need to pass
  247.     the path and file name to your MAX.PRM file.  See the command line
  248.     switch, /m, on how to pass it to MUE.
  249.  
  250.     Other files created/used are MUE.CFG, MUE.HLP, USER.BAK, USER.EXT,
  251.     USER.EXB, and USER.PRG.
  252.  
  253.     MUE.CFG is where your configuration settings are stored.
  254.  
  255.     MUE.HLP is a flat ASCII text file that is displayed when F1 is pressed.
  256.     This file can be custom configured to suit your personal needs, the
  257.     only limitation are the file cannot exceed 21 lines or have lines
  258.     longer than 80 characters.  Any text outside of these limits are simply
  259.     truncated.
  260.  
  261.     USER.BAK is created when packing or purging the user base.  It's simply
  262.     a backup of your USER.BBS file prior to packing/purging.
  263.  
  264.     USER.EXT is where MUE stores any user descriptions.  This file is
  265.     compatible with UEDIT, so if you used it with UED then you'll still
  266.     have your descriptions.
  267.  
  268.     USER.EXB is simply a backup of the USER.EXT file prior to packing/
  269.     purging users.
  270.  
  271.     ───────────────────────── Configuration Menu: ─────────────────────────
  272.  
  273.     Color Options:
  274.  
  275.     This option may be misleading, you cannot actually set colors per se,
  276.     rather you can only choose predefined color settings.  Mono is the
  277.     choice for monochrome monitors.  Color1 or Color2 are of course for
  278.     systems with a color monitor.
  279.  
  280.     Date Format:
  281.  
  282.     Here's where you choose your date format for any displayed date field.
  283.     Choices are MM/DD/YY, DD/MM/YY, or YY/MM/DD.
  284.  
  285.     Key Labels:
  286.  
  287.     Here's where you can define the purpose of the keys as used on your
  288.     system.  The definitions are displayed when you choose the 'K' Keys
  289.     hotkey while viewing a user record.  They're displayed in the Expire
  290.     field (above the Keys field).
  291.  
  292.     Log File Name:
  293.  
  294.     Specifying a file name here will turn on logging when packing/purging
  295.     the user base.
  296.  
  297.     Show Password:
  298.  
  299.     This option toggles whether or not passwords are displayed while
  300.     viewing user records.  This can be toggled via the '=' key as well.
  301.     Note that Sysop level users passwords are not displayed.  This is a
  302.     minor attempt at security for any prying eyes.  If you really need to
  303.     view a Sysop level users password then you need to edit it using the W
  304.     hotkey.  You can of course just press ESC to abort any changes after
  305.     viewing it.
  306.  
  307.     1Sort Ascend/Descend:
  308.  
  309.     Toggling this will determine whether or not the Major sort is ascending
  310.     or descending.
  311.  
  312.     2Sort Ascend/Descend:
  313.  
  314.     Toggling this will determine whether or not the Secondary sort is
  315.     ascending or descending.
  316.  
  317.     SOund:
  318.  
  319.     This option toggles sound, some pop-up boxes beep if on.
  320.  
  321.     SaVe Settings:
  322.  
  323.     Save your settings to the MUE.CFG file.  All settings in the
  324.     Configuration as well as the Global > Key and Global > Purge Settings
  325.     menus are saved via this option.
  326.  
  327.     ────────────────────────────── File Menu: ─────────────────────────────
  328.  
  329.     Append Record:
  330.  
  331.     This menu choice allows you to add a new user record.  It defaults to a
  332.     user name of "New Record Created by MUE".  Default settings via Maximus
  333.     are also set, such as Message area, File area, and Access level.  It's
  334.     up to you to fill in the blanks beyond this.
  335.  
  336.     Pack User File:
  337.  
  338.     Pack/Purge the user base file.  Settings in the Global > Purge Settings
  339.     are also processed with this choice.
  340.  
  341.     Restore a User:
  342.  
  343.     Have you ever deleted a user and wished there a way to put them back?
  344.     If so, then look no further!  :-)  You now have the ability to do it
  345.     assuming you used MUE to delete/purge it.
  346.  
  347.     Choosing this option loads the USER.PRG file and allows you to TAG
  348.     user(s) to restore.  After tagging (pressing the space bar), press
  349.     escape and you'll be prompted to restore them.  Keep in mind that any
  350.     descriptions you may have had for the user(s) were lost in the pack/
  351.     purge process and cannot be restored.
  352.  
  353.     ───────────────────────────── Global Menu: ────────────────────────────
  354.  
  355.     Key Settings:
  356.  
  357.     This menu choice allows you to do a mass/global change on users keys.
  358.     First you need to choose which access levels to act on, second is the
  359.     keys you want to turn on or off.
  360.  
  361.     It should be straight forward for the access levels, either they're ON
  362.     or OFF.  ON means they're processed, OFF are not.
  363.  
  364.     Key settings are -, ON, or OFF.  Key(s) set to '-' are ignored, keys
  365.     set to ON are turned on for all access levels set to ON, and keys set
  366.     to OFF are turned off for access levels set to ON.
  367.  
  368.     Once you make your choices, pressing control-P prompts you to process
  369.     them.
  370.  
  371.     Purge Settings:
  372.  
  373.     This menu is where you set the purge settings.  Access levels set to
  374.     NO are not processed.
  375.  
  376.     If an Access level is set to YES then MUE looks at the number of days.
  377.     Users that have called less than number of DAYS are purged unless
  378.     they have exceeded the number of CALLS.
  379.  
  380.     Note that values of 0 for DAYS or CALLS are ignored.  Here's some
  381.     examples:
  382.  
  383.       ACS = NO                           This level is ignored completely,
  384.                                          regardless of DAYS or CALLS.
  385.  
  386.       ACS = YES  DAYS =  0  CALLS =  0   This level is ignored completely,
  387.                                          because DAYS are set to 0 and
  388.                                          CALLS are also set to 0.
  389.  
  390.       ACS = YES  DAYS = 10  CALLS =  0   Callers in this level are purged
  391.                                          if they haven't called for 10
  392.                                          days or longer regardless of how
  393.                                          many times they have called.
  394.  
  395.       ACS = YES  DAYS = 30  CALLS = 10   Callers in this level are purged
  396.                                          if they haven't called for 30
  397.                                          days or more and have only called
  398.                                          10 or less times.
  399.  
  400.     Save As Sorted:
  401.  
  402.     ************READ THE FOLLOWING IF YOU USE THIS MENU CHOICE!************
  403.  
  404.     When saving the user base after sorting it, the USER.IDX file MUST BE
  405.     DELETED!  MUE will do this automatically, however, if you sort the user
  406.     base in a temporary directory and move it manually, you must delete the
  407.     USER.IDX file.  Failing to delete this file will yield mixed results
  408.     when Maximus is ran.  Typically Maximus will only see YOUR record and
  409.     the second record in the user base.  Deleting the USER.IDX file will
  410.     not harm anything as Maximus recreates it the next time it is ran.
  411.  
  412.     This option is only available if the user base has been sorted.  This
  413.     will save the user base as sorted.
  414.  
  415.     Sort User File:
  416.  
  417.     Here's where you can sort the user base.  This does a sort of the base
  418.     in memory, if you want to save the base as sorted then you need to use
  419.     the Global > Save As Sorted menu option.
  420.  
  421.     There is an option to sort on a secondary field.  Highlight the field
  422.     you want to sort as a secondary basis and press the space bar.  This
  423.     will mark the field with >< characters to indicate your choice.
  424.  
  425.     Highlighting a field and pressing enter will sort the user base based
  426.     on the field highlighted.  This is the major sort, in other words the
  427.     entire base is sorted on the field you press enter on.  Secondary sorts
  428.     sort within the major sort.  For example, if you choose Last Name for
  429.     the secondary sort, and do the major sort on AccessLvl, the the entire
  430.     base is sorted by the AccessLvl.  The users within the AccessLvl's are
  431.     then sorted by their last name.
  432.  
  433.     There are options that determine whether or not the sorts are done in
  434.     ascending or descending order.  These can be set from within the
  435.     Configuration menu, look at the 1Sort and 2Sort options.
  436.  
  437.     ─────────────────────────────── Credits: ──────────────────────────────
  438.  
  439.     Before I forget, I have to give credit to Gary Zarzycki for a lot of
  440.     the nuts and bolts in this program.  There are too many to list here,
  441.     but suffice it to say that were it not for him this program wouldn't
  442.     be where it is now (if ever), thanks Gary!
  443.  
  444.     For the second color option, I thank Gary Gilmore.  I liked it so much
  445.     I bought the company!  :-)  Okay I just implemented the colors, but I
  446.     do like them more than my original choice.  See the COLOR2 option in
  447.     the Config Menu > Color Options for his suggestion.
  448.  
  449.     There are lots of others that have contributed and I apologize for not
  450.     mentioning their names here, though a lot of them are mentioned in the
  451.     history.txt file.  Thanks guys!
  452.  
  453.     And of course I can't forget Scott Dudley for creating and maintaining
  454.     Maximus, thanks Scott!
  455.  
  456.